msg-service API

msg-service supports 9 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/msg/tagmenucreate POST version		Input:	Output:
	Description: Create a new menu for T301B tags. Example 1: Creates a menu with name 'search for equipment', containing two items: 'nearest wheelchair' and 'nearest IV pump' /epe/msg/tagmenucreate?name=search for equipment&item=nearest wheelchair&item=nearest IV pump Role Required: tagoperator Call Counter: Total: 0, Failed: 0	name (required) - [String] name of the menu description (optional) - [String] an optional description item (optional) - [Array] list of menu items	MENU.tagmenuid - [long] id of the newly created menu
/epe/msg/tagmenudelete POST version		Input:	Output:
	Description: Deletes a tag menu. Example 1: Delete menu with id 89 /epe/msg/tagmenudelete?tagmenuid=89 Role Required: tagoperator Call Counter: Total: 0, Failed: 0	tagmenuid (required) - [long] id of the menu to delete
/epe/msg/tagmenuedit POST version		Input:	Output:
	Description: Modify an existing menu. Supports all the same parameters as tagmenucreate. name and description may be omitted to retain the existing value, but menu items are overwritten with what is given here. You need to resupply the existing items to keep them, and if parameter item is omitted, the menu is cleared of items. The modification command is put into the command queue of all tags that have the modified menu associated with them. Example 1: Add a new item to the menu with id 10. Keep the old name and description. /epe/msg/tagmenuedit?tagmenuid=10&item=an existing item&item=a new item Example 2: Clear all items from the menu with id 11, and change its description. /epe/msg/tagmenuedit?tagmenuid=11&description=an empty menu Role Required: tagoperator Call Counter: Total: 0, Failed: 0	tagmenuid (required) - [long] id of the menu to edit name (optional) - [String] name of the menu description (optional) - [String] an optional description item (optional) - [Array] list of menu items
/epe/msg/tagmenulist POST version		Input:	Output:
	Description: Lists all tag menus, or a single one if tagmenuid is given. Example 1: List all tag menus /epe/msg/tagmenulist Role Required: viewer Call Counter: Total: 0, Failed: 0	tagmenuid (optional) - [long] id of the menu to show	MENU.tagmenuid - [long] id of the menu MENU.name - [String] name of the menu MENU.description - [String] description of the menu MENU.item - [Array] list of menu items
/epe/msg/tagsendmsg POST version		Input:	Output:
	Description: Send a message to one or more tags. The message is put pending into the tags' command queues and is delivered to each tag when they do their next maintenance. If the request contains tags that lack the capability to receive messages, these tags are skipped and listed in the ignore list given as reponse. So if a tag group contains both display and non-display tags, the group send just ignores non-display tags and sends normally to any display tags in the group. Example 1: Send a message to tags 1 and 2 /epe/msg/tagsendmsg?tagid=1,2&message=testing text message Example 2: Send an instant message to tags in the group with id 14405 /epe/msg/tagsendmsg?taggroupid=14405&messagetype=instant&message=testing instant message Role Required: tagoperator Call Counter: Total: 0, Failed: 0	message (required) - [String] content of the message tagid (optional) - [Array] ids of the tags mac (optional) - [Array] MACs of the tags groupid (optional) - [Array] ids of the tag groups messagetype (optional) - [String] "priority" to send a priority message, "instant" to send an instant message priority (optional) - [int] message priority options (optional) - [int] options for priority message expiretime (optional) - [long] expiration time in seconds for priority message menuitem (optional) - [Array] list of menu items for priority message	IGNOREDTAGS.tagid - [Array] ids of tags that were skipped because they lack the capability to receive messages IGNOREDTAGS.mac - [Array] equivalent to tagid, provides MAC addresses instead of tagids MESSAGEPENDING.tagid - [Array] ids of tags that now have the message pending MESSAGEPENDING.mac - [Array] equivalent to tagid, provides MAC addresses instead of tagids MESSAGEPENDING.messageid - [Array] id that was given to the message for this tag
/epe/msg/tagsetmenu POST version		Input:	Output:
	Description: Associate a menu with a display tag. Give 0 as tagmenuid to remove menu association. Example 1: Associate menu with id 10 with tag 1234 /epe/msg/tagsetmenu?tagid=1234&tagmenuid=10 Example 2: Unset menu of tag 1234 /epe/msg/tagsetmenu?tagid=1234&tagmenuid=0 Role Required: tagoperator Call Counter: Total: 0, Failed: 0	tagmenuid (required) - [long] menu id, 0 will unset the association tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device
/epe/msg/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/msg/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/msg/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 0, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/msg/_list?help=1)